<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader: fsl_otfad_driver.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kinetis Bootloader
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">Common bootloader for Kinetis devices</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Introduction</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fsl__otfad__driver_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">fsl_otfad_driver.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2014, Freescale Semiconductor, Inc.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without modification,</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * are permitted provided that the following conditions are met:</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * o Redistributions of source code must retain the above copyright notice, this list</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *   of conditions and the following disclaimer.</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * o Redistributions in binary form must reproduce the above copyright notice, this</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *   list of conditions and the following disclaimer in the documentation and/or</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *   other materials provided with the distribution.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * o Neither the name of Freescale Semiconductor, Inc. nor the names of its</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *   contributors may be used to endorse or promote products derived from this</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *   software without specific prior written permission.</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef _fsl_otfad_h</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#define _fsl_oftad_h</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;bootloader_common.h&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &quot;otfad/hal/fsl_otfad_hal.h&quot;</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">// Definitions</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="group__otfad.html#ga9ccaabd10a0589a6eddce32a8d830f0d">   45</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="group__otfad.html#ga9ccaabd10a0589a6eddce32a8d830f0d">_otfad_driver_errors</a></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;{</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    kStatus_OtfadSecurityViolation = MAKE_STATUS(<a class="code" href="group__bl__core.html#ggae9db7782b7f2dccb1dc6423be46ffc96a64605e39ebfb169850811207616c7823">kStatusGroup_OTFADDriver</a>, 0),</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    kStatus_OtfadLogicallyDisabled = MAKE_STATUS(<a class="code" href="group__bl__core.html#ggae9db7782b7f2dccb1dc6423be46ffc96a64605e39ebfb169850811207616c7823">kStatusGroup_OTFADDriver</a>, 1),</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    kStatus_OtfadInvalidKey = MAKE_STATUS(<a class="code" href="group__bl__core.html#ggae9db7782b7f2dccb1dc6423be46ffc96a64605e39ebfb169850811207616c7823">kStatusGroup_OTFADDriver</a>, 2),</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    kStatus_OtfadInvalidKeyBlob = MAKE_STATUS(<a class="code" href="group__bl__core.html#ggae9db7782b7f2dccb1dc6423be46ffc96a64605e39ebfb169850811207616c7823">kStatusGroup_OTFADDriver</a>, 3)</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;};</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__otfad.html">   57</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>OtfadKek</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;{</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__otfad.html#a95c1e7145d203e27f75f85e363e575e8">   59</a></span>&#160;    uint32_t <a class="code" href="group__otfad.html#a95c1e7145d203e27f75f85e363e575e8">keyWord0</a>; </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="group__otfad.html#a7bf2cb34d45af9edb8c0558a8e76c1ae">   60</a></span>&#160;    uint32_t <a class="code" href="group__otfad.html#a7bf2cb34d45af9edb8c0558a8e76c1ae">keyWord1</a>; </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="group__otfad.html#a04734659291e20efea5d58d4ad42d9a1">   61</a></span>&#160;    uint32_t <a class="code" href="group__otfad.html#a04734659291e20efea5d58d4ad42d9a1">keyWord2</a>; </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="group__otfad.html#a59b01c9f83f064b79b3fa06e5e9f5883">   62</a></span>&#160;    uint32_t <a class="code" href="group__otfad.html#a59b01c9f83f064b79b3fa06e5e9f5883">keyWord3</a>; </div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;} <a class="code" href="group__otfad.html#structotfad__kek__t">otfad_kek_t</a>;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">// Prototypes</span></div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="preprocessor">#if defined(__cplusplus)</span></div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="preprocessor">#endif // __cplusplus</span></div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<a class="code" href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code" href="group__otfad.html#gabc5e2cd3ad225e64ec0d26c738d06ff9">otfad_init</a>(uint32_t instance, <span class="keyword">const</span> uint8_t *keyBlobs, <span class="keyword">const</span> <a class="code" href="group__otfad.html#structotfad__kek__t">otfad_kek_t</a> *kek);</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="preprocessor">#if defined(__cplusplus)</span></div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;}</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="preprocessor">#endif // __cplusplus</span></div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="preprocessor">#endif // _fsl_otfad.h_</span></div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment">// EOF</span></div><div class="ttc" id="group__otfad_html_a95c1e7145d203e27f75f85e363e575e8"><div class="ttname"><a href="group__otfad.html#a95c1e7145d203e27f75f85e363e575e8">otfad_kek_t::keyWord0</a></div><div class="ttdeci">uint32_t keyWord0</div><div class="ttdoc">Word0: KEY[31:0][A03, A02, A01, A00]. </div><div class="ttdef"><b>Definition:</b> fsl_otfad_driver.h:59</div></div>
<div class="ttc" id="group__otfad_html_ga9ccaabd10a0589a6eddce32a8d830f0d"><div class="ttname"><a href="group__otfad.html#ga9ccaabd10a0589a6eddce32a8d830f0d">_otfad_driver_errors</a></div><div class="ttdeci">_otfad_driver_errors</div><div class="ttdoc">OTFAD Driver status codes. </div><div class="ttdef"><b>Definition:</b> fsl_otfad_driver.h:45</div></div>
<div class="ttc" id="group__otfad_html_a04734659291e20efea5d58d4ad42d9a1"><div class="ttname"><a href="group__otfad.html#a04734659291e20efea5d58d4ad42d9a1">otfad_kek_t::keyWord2</a></div><div class="ttdeci">uint32_t keyWord2</div><div class="ttdoc">Word2: KEY[31:0][A11, A10, A09, A08]. </div><div class="ttdef"><b>Definition:</b> fsl_otfad_driver.h:61</div></div>
<div class="ttc" id="group__otfad_html_a59b01c9f83f064b79b3fa06e5e9f5883"><div class="ttname"><a href="group__otfad.html#a59b01c9f83f064b79b3fa06e5e9f5883">otfad_kek_t::keyWord3</a></div><div class="ttdeci">uint32_t keyWord3</div><div class="ttdoc">Word3: KEY[31:0][A15, A14, A13, A12]. </div><div class="ttdef"><b>Definition:</b> fsl_otfad_driver.h:62</div></div>
<div class="ttc" id="group__otfad_html_a7bf2cb34d45af9edb8c0558a8e76c1ae"><div class="ttname"><a href="group__otfad.html#a7bf2cb34d45af9edb8c0558a8e76c1ae">otfad_kek_t::keyWord1</a></div><div class="ttdeci">uint32_t keyWord1</div><div class="ttdoc">Word1: KEY[31:0][A07, A06, A05, A04]. </div><div class="ttdef"><b>Definition:</b> fsl_otfad_driver.h:60</div></div>
<div class="ttc" id="group__bl__core_html_ggae9db7782b7f2dccb1dc6423be46ffc96a64605e39ebfb169850811207616c7823"><div class="ttname"><a href="group__bl__core.html#ggae9db7782b7f2dccb1dc6423be46ffc96a64605e39ebfb169850811207616c7823">kStatusGroup_OTFADDriver</a></div><div class="ttdoc">OTFAD driver status group number. </div><div class="ttdef"><b>Definition:</b> bootloader_common.h:158</div></div>
<div class="ttc" id="group__ksdk__common_html_gaaabdaf7ee58ca7269bd4bf24efcde092"><div class="ttname"><a href="group__ksdk__common.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a></div><div class="ttdeci">int32_t status_t</div><div class="ttdoc">Type used for all status and error return values. </div><div class="ttdef"><b>Definition:</b> fsl_common.h:121</div></div>
<div class="ttc" id="group__otfad_html_structotfad__kek__t"><div class="ttname"><a href="group__otfad.html#structotfad__kek__t">otfad_kek_t</a></div><div class="ttdoc">Format of OTFAD key wrap key (KEK). </div><div class="ttdef"><b>Definition:</b> fsl_otfad_driver.h:57</div></div>
<div class="ttc" id="group__otfad_html_gabc5e2cd3ad225e64ec0d26c738d06ff9"><div class="ttname"><a href="group__otfad.html#gabc5e2cd3ad225e64ec0d26c738d06ff9">otfad_init</a></div><div class="ttdeci">status_t otfad_init(uint32_t instance, const uint8_t *keyBlobs, const otfad_kek_t *kek)</div><div class="ttdoc">Initialize. </div><div class="ttdef"><b>Definition:</b> fsl_otfad_driver.c:157</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c718a368270b13c54d94892d20736f45.html">drivers</a></li><li class="navelem"><a class="el" href="dir_7fc47d6f8c605ce987eee9ad784a6202.html">otfad</a></li><li class="navelem"><b>fsl_otfad_driver.h</b></li>
    <li class="footer">Generated on Mon Mar 7 2016 16:48:23 for Kinetis Bootloader by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
